ASP.NET MVC Controls | ComponentOne
C1.Web.Mvc Namespace / FlexGridBase<T> Class
Properties Methods


In This Topic
    FlexGridBase<T> Class Members
    In This Topic

    The following tables list the members exposed by FlexGridBase<T>.

    Public Properties
     NameDescription
    Public PropertyAllowAddNewGets or sets a value that indicates whether the grid should provide a new row template so users can add items to the source collection.  
    Public PropertyAllowDeleteGets or sets a value that indicates whether the grid should delete selected rows when the user presses the Delete key.  
    Public PropertyAllowDraggingGets or sets whether users are allowed to drag rows and/or columns with the mouse.  
    Public PropertyAllowMergingGets or sets which parts of the grid provide cell merging.  
    Public PropertyAllowResizingGets or sets whether users are allowed to resize rows and/or columns with the mouse.  
    Public PropertyAlternatingRowStepGets or sets a value that determines the number of regular rows between 'alternating' rows.  
    Public PropertyAnchorCursorGets or sets a value that determines whether extending selections with the mouse or keyboard should change the start (cursor) or the end of the current selection.  
    Public PropertyAriaLabelGets or sets the aria label property of cells host.  
    Public PropertyAutoClipboardGets or sets whether the grid should handle clipboard shortcuts.  
    Public PropertyAutoGenerateColumnsGets or sets whether the grid should generate columns automatically based on the itemsSource.  
    Public PropertyAutoRowHeightsGets or sets a value that determines whether the grid should automatically resize the rows when the data or grid layout change.  
    Public PropertyAutoScrollGets or sets a value that determines whether the grid should automatically scroll its contents while users drag rows or columns into new positions.  
    Public PropertyAutoSearchGets or sets a value that determines whether the grid should search for cells as the users types into read-only cells.  
    Public PropertyAutoSizeModeGets or sets which cells should be taken into account when auto-sizing a row or column.  
    Public PropertyBigCheckboxesGets or sets a value that determines whether the checkboxes used to edit boolean columns should extend to cover the whole cell width.  
    Public PropertyBottomLeftCellsTemplateGets the templates applied in bottom left cells.  
    Public PropertyCaseSensitiveSearchGets or sets a value that determines whether searches performed while the user types should case-sensitive.  
    Public PropertyCellsTemplateGets the templates for the content cells.  
    Public PropertyChildItemsPathGets or sets the name of the property used to generate child rows in hierarchical grids.  
    Public PropertyCloneFrozenCellsGets or sets a value that determines whether the FlexGrid should clone frozen cells and show them in a separate element to improve perceived performance while scrolling.  
    Public PropertyColumnFootersRowHeaderTextGets or sets the text for the group row header in the column footers panel.  
    Public PropertyColumnFootersTemplateGets the templates applied in column footers cells.  
    Public PropertyColumnHeadersTemplateGets the templates applied in the column header cells.  
    Public PropertyColumnLayoutGets or sets a JSON string that defines the current column layout." remarks="The column layout string represents an array with the columns and their properties. It can be used to persist column layouts defined by users so they are preserved across sessions, and can also be used to implement undo/redo functionality in applications that allow users to modify the column layout.  
    Public PropertyColumnsGets the grid's column collection.  
    Public PropertyCommitEmptyEditsGets or sets a value that indicates how the grid commit empty edits to cell values.  
    Public PropertyComponentsGets the child components. (Inherited from C1.Web.Mvc.Component)
    Public PropertyCopyHeadersGets or sets copied header cells when copying the content to the clipboard.  
    Public PropertyCssClassGets or sets the css class of the control. (Inherited from C1.Web.Mvc.Control)
    Public PropertyCssStylesGets the CSS style applied in the control. (Inherited from C1.Web.Mvc.Control)
    Public PropertyDefaultColumnSizeGets or sets the default size of columns in the column collection.  
    Public PropertyDefaultRowSizeGets or sets the default size of rows in the row collection.  
    Public PropertyDefaultTypeWidthGets the static object that defines the default width for auto-generated grid columns based on their types.  
    Public PropertyDeferResizingGets or sets whether row and column resizing should be deferred until.  
    Public PropertyErrorTipGets the error tooltip of FlexGrid.  
    Public PropertyExpandSelectionOnCopyPasteGets or sets a value that determines whether the grid should automatically expand the selection to include cells in merged ranges when copying or pasting content to/from the clipboard.  
    Public PropertyExtendersGets the extender collection.  
    Public PropertyFrozenColumnsGets or sets the number of frozen columns.  
    Public PropertyFrozenRowsGets or sets the number of frozen columns.  
    Public PropertyGroupHeaderFormatGets or sets the format string used to create the group header content.  
    Public PropertyGroupSummaryPositionGets or sets a value that determines the position of group summary row in the group. This property does not work if ChildItemsPath property is set.  
    Public PropertyHeadersFocusabilityGets or sets a value that determines whether the row and column headers are focusable.  
    Public PropertyHeadersVisibilityGets or sets a value that determines whether the row and column headers are visible.  
    Public PropertyHeaderTemplate  
    Public PropertyHeightGets or sets the height of the control. (Inherited from C1.Web.Mvc.Control)
    Public PropertyHtmlAttributesGets the HTML attributes. (Inherited from C1.Web.Mvc.Control)
    Public PropertyIdGets or sets the component id. (Inherited from C1.Web.Mvc.Component)
    Public PropertyImeEnabledGets or sets a value that determines whether the grid should support Input Method Editors (IME) while not in edit mode.  
    Public PropertyIsDisabledGets or sets a value that determines whether the control is disabled. (Inherited from C1.Web.Mvc.Control)
    Public PropertyIsReadOnlyGets or sets whether the user can edit the grid cells by typing into them.  
    Public PropertyIsTemplateGets or sets a boolean value which indicates whether transfer this control to template mode. (Inherited from C1.Web.Mvc.Control)
    Public PropertyItemFormatterGets or sets a formatter function used to customize cells on this grid.  
    Public PropertyItemsSourceGets or sets ItemsSource settings. (Inherited from C1.Web.Mvc.ItemsBoundControl<T>)
    Public PropertyItemsSourceIdGets or sets the ItemsSourceId specify which CollectionViewService will be used for this control. (Inherited from C1.Web.Mvc.ItemsBoundControl<T>)
    Public PropertyItemValidatorGets or sets a validator function to determine whether cells contain valid data.  
    Public PropertyKeyActionEnterGets or sets the action to perform when the ENTER key is pressed.  
    Public PropertyKeyActionTabGets or sets the action to perform when the TAB key is pressed.  
    Public PropertyLazyRenderGets or sets whether the grid should skip rendering cells that were updated in the last render cycle.  
    Public PropertyNewRowAtTopGets or sets a value that indicates whether the new row template should be located at the top of the grid or at the bottom.  
    Public PropertyOnClientAutoSizedColumnOccurs after the user auto-sizes a column by double-clicking the right edge of a column header cell.  
    Public PropertyOnClientAutoSizedRowOccurs after the user auto-sizes a row by double-clicking the bottom edge of a row header cell.  
    Public PropertyOnClientAutoSizingColumnOccurs before the user auto-sizes a column by double-clicking the right edge of a column header cell.  
    Public PropertyOnClientAutoSizingRowOccurs before the user auto-sizes a row by double-clicking the bottom edge of a row header cell.  
    Public PropertyOnClientBeginningEditOccurs before a cell enters edit mode.  
    Public PropertyOnClientCellEditEndedOccurs when a cell edit has been committed or canceled.  
    Public PropertyOnClientCellEditEndingOccurs when a cell edit is ending.  
    Public PropertyOnClientCopiedOccurs after the user has copied the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).  
    Public PropertyOnClientCopyingOccurs when the user is copying the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).  
    Public PropertyOnClientDeletedRowOccurs after the user has deleted a row by pressing the Delete key.  
    Public PropertyOnClientDeletingRowOccurs when the user is deleting a selected row by pressing the Delete key (see the allowDelete property).  
    Public PropertyOnClientDraggedColumnOccurs when the user finishes dragging a column.  
    Public PropertyOnClientDraggedRowOccurs when the user finishes dragging a row.  
    Public PropertyOnClientDraggingColumnOccurs when the user starts dragging a column.  
    Public PropertyOnClientDraggingColumnOverOccurs as the user drags a column to a new position.  
    Public PropertyOnClientDraggingRowOccurs when the user starts dragging a row.  
    Public PropertyOnClientDraggingRowOverOccurs as the user drags a row to a new position.  
    Public PropertyOnClientFormatItemOccurs when an element representing a cell has been created.  
    Public PropertyOnClientGotFocusOccurs when the control gets the focus. (Inherited from C1.Web.Mvc.Control)
    Public PropertyOnClientGroupCollapsedChangedOccurs after a group has been expanded or collapsed.  
    Public PropertyOnClientGroupCollapsedChangingOccurs when a group is about to be expanded or collapsed.  
    Public PropertyOnClientItemsSourceChangedOccurs after the grid has been bound to a new items source.  
    Public PropertyOnClientItemsSourceChangingOccurs after the grid has been bound to a new items source.  
    Public PropertyOnClientLoadedRowsOccurs after the grid rows have been bound to the data source.  
    Public PropertyOnClientLoadingRowsOccurs before the grid rows are bound to the data source.  
    Public PropertyOnClientLostFocusOccurs when the control loses the focus. (Inherited from C1.Web.Mvc.Control)
    Public PropertyOnClientPastedOccurs after the user has pasted content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).  
    Public PropertyOnClientPastedCellOccurs after the user has pasted content from the clipboard into a cell.  
    Public PropertyOnClientPastingOccurs when the user is pasting content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).  
    Public PropertyOnClientPastingCellOccurs when the user is pasting content from the clipboard into a cell.  
    Public PropertyOnClientPinnedColumnOccurs as columns are pinned.  
    Public PropertyOnClientPinningColumnOccurs as columns are pinning.  
    Public PropertyOnClientPrepareCellForEditOccurs when an editor cell is created and before it becomes active.  
    Public PropertyOnClientRefreshedOccurs after the control has refreshed its contents. (Inherited from C1.Web.Mvc.Control)
    Public PropertyOnClientRefreshingOccurs when the control is about to refresh its contents. (Inherited from C1.Web.Mvc.Control)
    Public PropertyOnClientResizedColumnOccurs when the user finishes resizing a column.  
    Public PropertyOnClientResizedRowOccurs when the user finishes resizing rows.  
    Public PropertyOnClientResizingColumnOccurs as columns are resized.  
    Public PropertyOnClientResizingRowOccurs as rows are resized.  
    Public PropertyOnClientRowAddedOccurs when the user creates a new item by editing the new row template (see the allowAddNew property).  
    Public PropertyOnClientRowEditEndedOccurs when a row edit has been committed or canceled.  
    Public PropertyOnClientRowEditEndingOccurs when a row edit is ending, before the changes are committed or canceled.  
    Public PropertyOnClientRowEditStartedOccurs after a row enters edit mode.  
    Public PropertyOnClientRowEditStartingOccurs before a row enters edit mode.  
    Public PropertyOnClientScrollPositionChangedOccurs after the control has scrolled.  
    Public PropertyOnClientSelectionChangedOccurs after selection changes.  
    Public PropertyOnClientSelectionChangingOccurs before selection changes.  
    Public PropertyOnClientSortedColumnOccurs after the user applies a sort by clicking on a column header.  
    Public PropertyOnClientSortingColumnOccurs before the user applies a sort by clicking on a column header.  
    Public PropertyOnClientUpdatedLayoutOccurs after the grid has updated its internal layout.  
    Public PropertyOnClientUpdatedViewOccurs when the grid finishes creating/updating the elements that make up the current view.  
    Public PropertyOnClientUpdatingLayoutOccurs before the grid updates its internal layout.  
    Public PropertyOnClientUpdatingViewOccurs when the grid starts creating/updating the elements that make up the current view.  
    Public PropertyPasteEmptyCellsGets or sets a value that determines whether when pasting, paste all cells or only not empty cells.  
    Public PropertyPinningTypeGets or sets how the grid pins the column headers by clicking the icons toggles the column's frozen state  
    Public PropertyPreserveOutlineStateGets or sets a value that determines whether the grid should preserve the expanded/collapsed state of nodes when the data is refreshed.  
    Public PropertyPreserveSelectedStateGets or sets a value that determines whether the grid should preserve the selected state of rows when the data is refreshed.  
    Public PropertyPreserveWhiteSpaceGets or sets a value that determines whether the grid should keep whitespace in cells as they appear in the data or whether it should collapse the whitespace into a single space character  
    Public PropertyQuickAutoSizeGets or sets a value that determines whether the grid should optimize performance over precision when auto-sizing columns.  
    Public PropertyRefreshOnEditGets or sets whether the grid should refresh all cells after a cell is edited.  
    Public PropertyRowHeaderPathGets or sets the name of the property used to create row header cells.  
    Public PropertyRowHeadersTemplateGets the templates applied in row header cells.  
    Public PropertyScrollPositionGets or sets the position of the grid's scrollbars.  
    Public PropertySelectionGets or sets the current selection.  
    Public PropertySelectionModeGets or sets the current selection mode.  
    Public PropertySelectorGets or sets the selector to macth the dom element(s) which the control is attached to. (Inherited from C1.Web.Mvc.Control)
    Public PropertyShowAlternatingRowsGets or sets a value that determines whether the grid should add the 'wj-alt' class to cells in alternating rows.  
    Public PropertyShowColumnFootersGets or sets a bool value which indicates whether to show a group row to display the aggregates in the column footers panel.  
    Public PropertyShowDropDownGets or sets a value that indicates whether the grid adds drop-down buttons to the cells in columns that have the ShowDropDown property set to true.  
    Public PropertyShowErrorsGets or sets a value that determines whether the grid should add the 'wj-state-invalid' class to cells that contain validation errors, and tooltips with error descriptions.  
    Public PropertyShowGroupsGets or sets whether the grid should insert group rows to delimit data groups.  
    Public PropertyShowMarqueeGets or sets a value that indicates whether the grid should display a marquee element around the current selection.  
    Public PropertyShowPlaceholdersGets or sets a value that determines whether the grid should use the column headers as placeholders when editing cells. This property only works with the grid's built-in editor. This property is not useful in IE.  
    Public PropertyShowSelectedHeadersGets or sets a value that indicates whether the grid should add class names to indicate selected header cells.  
    Public PropertyShowSortGets or sets whether the grid should display sort indicators in the column headers.  
    Public PropertySkipMergedGets or sets a value that determines whether when copying, skip cells that have been merged.  
    Public PropertySortingTypeGets or sets how the grid sort columns by clicking the column header cells.  
    Public PropertySortRowIndexGets or sets the index of row in the column header panel that shows and changes the current sort.  
    Public PropertyStickyHeadersGets or sets a value that determines whether column headers should remain when the user scrolls the window.  
    Public PropertyTabOrderGets or sets a value of the tabindex attribute associated with the control. (Inherited from C1.Web.Mvc.Control)
    Public PropertyTemplateBindingsGets the collection of the template bindings. (Inherited from C1.Web.Mvc.Control)
    Public PropertyTopLeftCellsTemplateGets the templates for the topleft cells.  
    Public PropertyTreeIndentGets or sets the indent used to offset row groups of different levels.  
    Public PropertyUniqueIdGets a value which represents the unique id for the control. (Inherited from C1.Web.Mvc.Control)
    Public PropertyValidateEditsGets or sets a value that determines whether the grid should remain in edit mode when the user tries to commit edits that fail validation.  
    Public PropertyVirtualizationThresholdsGets or sets the minimum number of rows and/or columns required to enable virtualization.  
    Public PropertyWidthGets or sets the width of the control. (Inherited from C1.Web.Mvc.Control)
    Top
    Protected Properties
     NameDescription
    Protected PropertyChildComponentsCreatedGets or sets a boolean value indicates whether child components are created. (Inherited from C1.Web.Mvc.Component)
    Protected PropertyHasScriptsGets a boolean value indicates whether current component has the scripts which need to be rendered. (Inherited from C1.Web.Mvc.Component)
    Protected PropertyTagKeyGets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from C1.Web.Mvc.Control)
    Protected PropertyUrlHelperGets the url helper. (Inherited from C1.Web.Mvc.Component)
    Top
    Public Methods
     NameDescription
    Public MethodRenderRender the component result to the writer. (Inherited from C1.Web.Mvc.Control)
    Public MethodToHtmlStringReturns an HTML-encoded string. (Inherited from C1.Web.Mvc.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodCreateChildComponentsCreates child components. (Inherited from C1.Web.Mvc.ItemsBoundControl<T>)
    Protected MethodEnsureChildComponentsEnsure the child components created. (Inherited from C1.Web.Mvc.Component)
    Protected MethodOnPreRenderThis method is performed before rendering. (Inherited from C1.Web.Mvc.Control)
    Protected MethodRegisterStartupScriptOverridden. Registers the start-up script.  
    Protected MethodRenderAttributesRenders the html attributes of control. (Inherited from C1.Web.Mvc.Control)
    Protected MethodRenderBeginTagRenders begin tag of control. (Inherited from C1.Web.Mvc.Control)
    Protected MethodRenderContentRenders content of control. (Inherited from C1.Web.Mvc.Control)
    Protected MethodRenderEndTagRenders end tag of control. (Inherited from C1.Web.Mvc.Control)
    Protected MethodRenderMarkupRenders the control markup. (Inherited from C1.Web.Mvc.Control)
    Top
    Extension Methods
     NameDescription
    Public Extension MethodToTemplateRender the html string in template mode.
    Top
    See Also

    Reference

    FlexGridBase<T> Class
    C1.Web.Mvc Namespace